home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / ragthr12.zip / GATHER.DOC < prev    next >
Text File  |  1993-02-20  |  7KB  |  210 lines
  1.  
  2.                            GATHER v. 1.20
  3.  
  4.                            Copyright 1993
  5.  
  6.                                  by
  7.                       Pass - the - Buck Software
  8.                            Independence, Mo.
  9.  
  10.  
  11. Gather is a simple, single purpose utility designed for use with the
  12. RemoteAccess (c) Bulletin Board System. It gathers the files on the
  13. system into an ALLFILES listing for download by system users.
  14.  
  15. Gather does NOT attempt to manage files or alter your files.bbs in any
  16. way. It is intended for, and well behaved in, unattended operation on
  17. a 80286 or better system. Gather was not designed to operate on an XT
  18. class machine. A version of Gather compiled with the 8088 instruction
  19. set is available upon request.
  20.  
  21. While Gather has been exhaustively tested and performs reliably in DOS,
  22. Windows and DesqView, it is impossible to guarantee it will work in all
  23. system configurations. The usual FreeWare/ShareWare disclaimers apply.
  24. Use this program at your own risk. 
  25.  
  26. This program may be used and freely distributed for all non-commercial
  27. uses in unmodified form and with all files included and intact.
  28.  
  29. For non-commercial usage of this program you are NOT required to 
  30. register or notify the author. I would appreciate a short FIDO NetMail
  31. message if you care to send one. Please let me know if the program
  32. is of value to you and behaves well on your system. Of course, also
  33. let me know if you have any problems with it.
  34.  
  35. NETMAIL:        Dave Perry      FIDO 1:280/19
  36.                                      1:280/32
  37.  
  38. I will receive mail addressed to either node.
  39.  
  40.  
  41. The author retains all intellectual property and distribution rights.
  42.  
  43.  
  44. INSTALLATION:
  45.  
  46. Create a directory to contain the GATHER files. This directory would
  47. normally contain:
  48.  
  49. GATHER.EXE    The executable file
  50. GATHER.CFG    The configuration file
  51. GATHER.DOC    This documentation (for future reference)
  52.  
  53. GATHER.HDR    User supplied ASCII text BBS Banner file
  54. GATHER.FTR    User supplied ASCII text file appended to end of listing.
  55. NEW.HDR       User supplied ASCII text BBS Banner file
  56. NEW.FTR       User supplied ASCII text file appended to end of listing.
  57.  
  58. All of the files listed may reside anywhere in the system as long as the
  59. complete path and file names are included in the configuration file. If
  60. the files are contained in the SAME directory as the .EXE file, only the
  61. file name need be listed in the config file.
  62.  
  63.  
  64. OPERATION:
  65.  
  66. Gather requires that the RA environment variable be set in your system.
  67. It uses this information to locate the FILES.RA control file used by RA.
  68. Gather reads this file to locate the FILES.BBS files in each of the system
  69. directories. See your RA documentation if this environment variable is
  70. not currently set. (It should be for proper operation of RA)
  71.  
  72. Gather expects to find the GATHER.CFG file in the current working directory.
  73. If the configuration file lives elswhere in the system, the command line
  74. MUST contain the complete path and file name for the file. This also makes
  75. it possible to use separate configuration files for different purposes or
  76. groups of users. If you wish to make different listings for different 
  77. security levels or for network MAGICNAME listings, just create the config
  78. files and call Gather with the path file names of the separate configurations.
  79.  
  80.  
  81. CONFIGURATION:
  82.  
  83. Following is a complete list of the configuration commands that can be
  84. used in configuring Gather for your system. The commands may be used in
  85. any order. 
  86.  
  87. The command must be the first thing on the line and may be in either
  88. upper or lower case. Following the command in the text is a sample
  89. parameter. Use this as a guideline to make it suit your system.
  90.  
  91. GATHER supports .arc .arj .lzh .pak .zip file compression utilities.
  92. It expects to find the compression program in a directory included in the
  93. DOS path statement or in the current working directory.
  94.  
  95.  
  96. ALLFILES d:\ra\files\bbsfiles.zip
  97.  
  98. Produce a file called BBSFILES compressed with PKZIP (c) in the indicated
  99. directory. The file name of the uncompressed file is ALLFILES.TXT by default.
  100.  
  101.  
  102. ALLTEXT 280-19.lst
  103.  
  104. Make the uncompressed allfile listing with the name 280-19.LST. This makes
  105. the uncompressed file identifiable with your system when the user has 
  106. downloaded several.
  107.  
  108.  
  109. NEWFILES d:\ra\files\bbsnew.zip
  110.  
  111. Produce a file called BBSNEW compressed with PKZIP (c) in the indicated
  112. directory. The file name of the uncompressed file is NEWFILES and is a listing
  113. of files that have arrived on the system in the last nn days. Use the NEWDAYS
  114. command (below) to set the number of days.
  115.  
  116.  
  117. NEWTEXT 280-19.new
  118.  
  119. Make the uncompressed NEW file listing with the name 280-19.NEW. This makes 
  120. the uncompressed file identifiable with your system when the user has 
  121. downloaded several.
  122.  
  123.  
  124. DIR_ID on
  125.  
  126. Some systems use file management utilities which modify the FILES.BBS file
  127. to include header information. This switch makes Gather compatable with
  128. most of these utilities. If this switch is OFF, Gather will not include
  129. a directory header or file summary in the each of the directories. The
  130. header placed in the FILES.BBS file will be used instead.
  131.  
  132.  
  133. NEWMARK *
  134.  
  135. Defines the character to use to indicate new files in the ALLFILE list.
  136. If this command is deleted or commented out and a new file search is
  137. indicated, the graphics character "■" is used by default.
  138.  
  139.  
  140. NEWDAYS 30
  141.  
  142. Defines the number of days to include in a NEW file search. If this
  143. command is deleted or commented out no NEW files will be indicated in
  144. the ALLFILE list and NO NEW files output file will be created. Valid
  145. NEWDAYS range from 1 to 255.
  146.  
  147.  
  148. HEADER [d:\dir\]gather.hdr
  149.  
  150. Path and file name to be prepended to the ALLFILE list. If the ASCII 
  151. text file lives in the current directory, only the file name is needed.
  152. If you wish to use a file used for archive commenting, you may use the
  153. full DOS path and file name to indicate that file. This file may be
  154. named anything you wish as long as it is a valid DOS file name.
  155.  
  156.  
  157. FOOTER [d:\dir\]gather.ftr
  158.  
  159. Same as above but file is appended to the end of the file listing.
  160.  
  161.  
  162. NEWHEADER [d:\dir\]new.hdr
  163.  
  164. Same as above but applies to NEW listing file.
  165.  
  166.  
  167. NEWFOOTER [d:\dir\]gather.ftr
  168.  
  169. Same as above but applies to NEW listing file.
  170.  
  171.  
  172. SECURITY 20
  173.  
  174. Sets the security level of user access to a specific directory for
  175. both the NEW and ALLFILE listings. All directories with user download
  176. access of 20 or less will be included in the list. Directories with
  177. user access of 21 or greater will not be included in the listings.
  178.  
  179.  
  180. LOGFILE d:\ra\ra.log
  181.  
  182. Complete DOS path and file name of logging file to use for Gather
  183. output. The default is GATHER.LOG in the current directory. Naming
  184. the path to the RA system log will result in the inclusion of Gather
  185. results in that file.
  186.  
  187.  
  188. I hope you find this utility of value. 
  189.  
  190. Dave Perry
  191. Pass - the - Buck SoftWare
  192. Independence, Mo.
  193. 1:280/19
  194.  
  195.  
  196. History:
  197.  
  198. 01/17/93
  199. v. 1.1
  200. First release of GATHER remade to operate with RemoteAccess from
  201. original designed for another BBS system.
  202.  
  203. 02/20/93
  204. v. 1.2
  205. Changed date comparison routine that was causing GATHER to ignore
  206. files uploaded in current month if month was not January. Had to 
  207. wait till February to find this one. Thanks to Mike Poston of the
  208. Sounding Board BBS for calling this to my attention.
  209.  
  210.